Skip to content

Retrieve ip-based restriction details

Request

Returns data about ip-based restriction for Hub.
If enabled only visitors from whitelisted IP addresser or IP ranges are allowed to access the Hub. All other visitors will see 404 error.
Supported address formats:

  • IP V4 address,
  • IP V4 range in CIDR notation.
Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/access_restriction/ip_whitelist?api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
enabledboolean
ip_whitelistArray of any
Example:
[
  "54.210.121.161",
  "144.201.96.0/21"
]
Response
{
  "enabled": true,
  "ip_whitelist": [
    "54.210.121.161",
    "144.201.96.0/21"
  ]
}